Prepare step

This endpoint gives information about workflow step mandatory parameters

Endpoint: /api/v1/workflows/{delegate}

Method: GET

Request Parameters

delegate (required): one of values GATEKEEPER, MODEL, DISTRIBUTION.

Responses

200 (OK) The request was successful, and the server has returned the expected workflow creation body sample.

Body:

{
  "message": "string",
  "timestamp": "2024-03-29T12:30:52.143Z",
  "data": {
    "delegate": "enum",
    "timeOutInSeconds": 60,
    "params": {
      "additionalProp1": {
        "strValue": "string",
        "longValue": "number",
        "doubleValue": "number",
        "type": "enum"
      },
      "additionalProp2": {
        "strValue": "string",
        "longValue": "number",
        "doubleValue": "number",
        "type": "enum"
      },
      "additionalProp3": {
        "strValue": "string",
        "longValue": "number",
        "doubleValue": "number",
        "type": "enum"
      }
    }
  },
  "version": "string"
}

401 (Unauthorized) This response is returned if the request is not authorized.

Body:

{
  "message": "Unauthorized request",
  "timestamp": "2023-09-28T15:37:14.222Z",
  "data": "string",
  "version": "string"
}

404 (Not Found) This response is returned if the required resources are not found.

Body:

{
  "message": "Not Found",
  "timestamp": "2023-09-28T15:37:14.222Z",
  "data": "string",
  "version": "string"
}

412 (Precondition Failed) This response is returned if a precondition is not met.

Body:

{
  "message": "Precondition failed",
  "timestamp": "2023-09-28T15:37:14.222Z",
  "data": {
    "additionalProp1": {},
    "additionalProp2": {},
    "additionalProp3": {}
  },
  "version": "string"
}

500 (Internal Server Error) This response is returned if an unexpected internal server error occurs.

Body:

{
  "message": "Internal Server Error",
  "timestamp": "2023-09-28T15:37:14.223Z",
  "data": "string",
  "version": "string"
}